Get campaign

cURL

curl --request GET \
  --url https://app.masivo.ai/api/storefront/v1/campaigns/{id} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "brand_id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "type": "BEHAVIOR",
    "rules": [
      {
        "conditions": [
          [
            {
              "type": "Order Value",
              "operator": "grater than",
              "primitive": "string",
              "value": 9.95
            }
          ]
        ],
        "effects": [
          {
            "reward_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "POINTS",
            "tier_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "reward": {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "brand_id": "<string>",
              "name": "<string>",
              "description": "<string>",
              "type": "POINTS",
              "conditions": [
                [
                  {
                    "type": "Order Value",
                    "operator": "grater than",
                    "primitive": "string",
                    "value": 9.95
                  }
                ]
              ],
              "attributes": {
                "conversion_factor": 0.1
              }
            },
            "expiration_date": "12/months",
            "amount": 1
          }
        ]
      }
    ],
    "attributes": {
      "trigger": "PURCHASE",
      "privacy": "PRIVATE"
    },
    "status": "RUNNING",
    "start_date": "2023-11-07T05:31:56Z",
    "end_date": "2023-11-07T05:31:56Z",
    "funded_by": "<string>",
    "budget": 1000
  }
}

GET

campaigns

{id}

cURL

curl --request GET \
  --url https://app.masivo.ai/api/storefront/v1/campaigns/{id} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "brand_id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "type": "BEHAVIOR",
    "rules": [
      {
        "conditions": [
          [
            {
              "type": "Order Value",
              "operator": "grater than",
              "primitive": "string",
              "value": 9.95
            }
          ]
        ],
        "effects": [
          {
            "reward_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "POINTS",
            "tier_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "reward": {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "brand_id": "<string>",
              "name": "<string>",
              "description": "<string>",
              "type": "POINTS",
              "conditions": [
                [
                  {
                    "type": "Order Value",
                    "operator": "grater than",
                    "primitive": "string",
                    "value": 9.95
                  }
                ]
              ],
              "attributes": {
                "conversion_factor": 0.1
              }
            },
            "expiration_date": "12/months",
            "amount": 1
          }
        ]
      }
    ],
    "attributes": {
      "trigger": "PURCHASE",
      "privacy": "PRIVATE"
    },
    "status": "RUNNING",
    "start_date": "2023-11-07T05:31:56Z",
    "end_date": "2023-11-07T05:31:56Z",
    "funded_by": "<string>",
    "budget": 1000
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

The campaign unique identifier

Response

data

object

Show child attributes

data.id

string<uuid>

The campaign internal unique identifier

data.brand_id

string | null

The brand id of the campaign, null if is a global campaign

data.name

string

The name of the campaign

data.description

string

The description of the campaign

data.type

enum<string>

The type of the campaign

Available options:

BEHAVIOR,

COUPONS,

PUNCH_CARDS

data.rules

object[]

Show child attributes

data.rules.conditions

object[][]

OR conditions

AND conditions

Show child attributes

data.rules.conditions.type

string

The type of the condition

Example:

"Order Value"

data.rules.conditions.operator

string

The operator to compare the attribute

Example:

"grater than"

data.rules.conditions.primitive

enum<string>

The primitive of the value to compare

Available options:

string,

number,

currency,

boolean,

absolute date,

relative date,

recurring date

data.rules.conditions.value

The value to compare

Example:

9.95

data.rules.effects

object[]

Option 1
Option 2

Show child attributes

data.rules.effects.reward_id

string<uuid>

The reward id to apply

data.rules.effects.type

enum<string>

The type of reward

Available options:

POINTS,

DISCOUNT,

GIFT_CARD,

PRODUCT

data.rules.effects.tier_id

string<uuid> | null

The tier to offer the reward. Null if is for all tiers

data.rules.effects.reward

object

Show child attributes

data.rules.effects.reward.id

string<uuid>

The reward internal unique identifier

data.rules.effects.reward.brand_id

string | null

The brand id of the reward, null if is a global reward

data.rules.effects.reward.name

string

The name of the reward

data.rules.effects.reward.description

string

The description of the reward

data.rules.effects.reward.type

enum<string>

The type of the reward

Available options:

POINTS,

DISCOUNT,

GIFT_CARD,

PRODUCT

data.rules.effects.reward.conditions

object[][]

OR conditions

AND conditions

Show child attributes

data.rules.effects.reward.conditions.type

string

The type of the condition

Example:

"Order Value"

data.rules.effects.reward.conditions.operator

string

The operator to compare the attribute

Example:

"grater than"

data.rules.effects.reward.conditions.primitive

enum<string>

The primitive of the value to compare

Available options:

string,

number,

currency,

boolean,

absolute date,

relative date,

recurring date

data.rules.effects.reward.conditions.value

The value to compare

Example:

9.95

data.rules.effects.reward.attributes

object

The attributes of the reward

Option 1
Option 2

Show child attributes

data.rules.effects.reward.attributes.conversion_factor

number

How much 1 point is worth in your currency

Example:

0.1

data.rules.effects.expiration_date

string

Rewards duration since issued

Example:

"12/months"

data.rules.effects.amount

number

The amount of the reward

Example:

1

data.attributes

object

The attributes of the campaign

Option 1
Option 2

Show child attributes

data.attributes.trigger

string

The trigger of the campaign

Example:

"PURCHASE"

data.attributes.privacy

enum<string>

The privacy of the campaign

Available options:

PRIVATE,

PUBLIC

data.status

enum<string>

The status of the campaign

Available options:

RUNNING,

PAUSED,

SCHEDULED,

FINISHED

data.start_date

string<date-time>

The start date of the campaign

data.end_date

string<date-time> | null

The end date of the campaign

data.funded_by

string | null

Who is funding these campaign

data.budget

number

The budget of the campaign

Example:

1000

Request referral code Get campaigns

⌘I

API Documentation

Endpoints

Guides

Resources

Authorizations

Path Parameters

Response